<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.5 [en] (X11; I; SunOS 5.5.1 sun4u) [Netscape]">
<title>TAO IDL compiler User's Guide</title>

<!--  -->

</head>
<body text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#CC0000">

<hr>
<h3>
TAO IDL Compiler User's Guide</h3>

<h3> Scope</h3> This document describes the options and features of
TAO IDL compiler.  It is not a reference manual or tutorial on OMG
IDL.  For more information on OMG IDL see the <A
HREF="http://www.omg.org/technology/documents/corba_spec_catalog.htm">
online CORBA specification</A> and the <A
HREF="http://www.triodia.com/staff/michi-henning.html">Advanced CORBA
Programming with C++</A> book.  More information on the design of
TAO's IDL compiler is also available <A
HREF="http://www.dre.vanderbilt.edu/~schmidt/PDF/ami1.pdf">online</A>.
Finally, comprehensive documentation on TAO's IDL compiler is
available in the OCI <A HREF="http://www.theaceorb.com/product/index.html">TAO
Developer's Guide</A>.<P>

<HR><P>
<h3>Optional CIAO Functionality</h3>

For users of the <b>Component Integrated ACE ORB</b>
(<a href="http://www.dre.vanderbilt.edu/~schmidt/CIAO.html"> CIAO</a>), it is
important to note that, in keeping with recent developments in
the OMG's Lightweight CORBA Component Model
(<a href="http://www.omg.org/technology/documents/formal/components.htm"> LwCCM</a>) specification,
CIAO's <i>Component Implementation Definition Language</i> (CIDL) compiler,
along with the .cidl files it processed, have been eliminated, and replaced
by additional functionality in the TAO IDL compiler. All the additional files
generated and command line options used are described below.

<HR><P>
<h3>Generated Files</h3>

The IDL compiler generates up to 16 files from each <tt>.idl</tt> file.  The
file names are obtained by taking the IDL <EM>basename</EM> and
appending the following suffixes (see the list of TAO's IDL compiler
<A HREF="#options">options</A> on how to get different suffixes for
these files:) <P>

<UL>
  <LI> <B><EM>Client stubs</EM></B>, <EM>i.e.</EM>, <tt>*C.h</tt>,
      <tt>*C.inl</tt>, and <tt>*C.cpp</tt>.  Pure client applications
      only need to <code>#include</code> and link with these files.
  <LI> <B><EM>Server skeletons</EM></B>, <EM>i.e.</EM>,  <tt>*S.h</tt>, and
      <tt>*S.cpp</tt>.  Servers need to <code>#include</code> and link
      with these files. Generation of these files may be suppressed with the <tt>-SS</tt> option.
  <LI> <B><EM>Server skeleton templates</EM></B>, <EM>i.e.</EM>, <tt>*S_T.h</tt>, <tt>S_T.inl</tt>,
      and <tt>*S_T.cpp</tt>.  Some C++ compilers do not like template
      and non-template code in the same files, so TAO's IDL compiler
      generates these files separately. These files define tie classes,
      used to enable servant inheritance trees, and are not generated by
      default.
  <LI> <B><EM>Anyop files</EM></B>, <EM>i.e.</EM>, <tt>*A.h</tt>,
       and <tt>*A.cpp</tt>. Optionally generated files containing
       typecode and Any insertion/extraction operator definitions.
       This option enables the contents of these files to remain
       unlinked if not used.
  <LI> <B><EM>CIAO servant files</EM></B>, <EM>i.e.</EM>, <tt>*_svnt.h</tt>,
      and <tt>*_svnt.cpp</tt>. Optionally generated files, containing component
      and home servant implementations, as well as factory functions to create
      components and homes.
  <LI> <B><EM>Executor IDL file</EM></B>, <EM>i.e.</EM>, <tt>*E.idl</tt>.
      IDL file containing local interfaces used for component and home
      executors, optionally generated.
  <LI> <B><EM>Executor implementation files</EM></B>, <EM>i.e.</EM>, <tt>*_exec.h</tt>,
      and <tt>*_exec.cpp</tt>. Optionally generated files containing executor implementation classes
      with empty function bodies for facet, supported and inherited operations,
      as well as factory functions to create component and home executors.
  <LI> <B><EM>Connector implementation files</EM></B>, <EM>i.e.</EM>, <tt>*_conn.h</tt>,
      and <tt>*_conn.cpp</tt>. Optionally generated files containing connector implementation classes
      with complete function bodies. The function implementations are specialized
      for DDS at present, but will be configurable to other connection mechanisms
      in the future.
  <LI> <B><EM>Export header files</EM></B>, <EM>i.e.</EM>, <tt>*_export.h</tt>.
      Optionally generated files defining export/import macros as well as
      corresponding macros related to singletons and tracing, all in terms of
      existing ACE macros. Note that, while these files must have the
      "_export.h" suffix, the base name of the file is usually not derived
      from the IDL filename, as is the stem of the other file groups above.
      There can be as many as 4 of these files per build, for stub, skeleton,
      servant, and executor export macros, and they may also be generated by
      the Perl script <tt>generate_export_file.pl</tt>, located in
      <tt>$ACE_ROOT/bin</tt>.
</UL>

TAO's IDL compiler creates separate <TT>*.inl</TT> and <TT>*S_T.*</TT>
files to improve the performance of the generated code.  For example,
the <TT>*.inl</TT> files enable you to compile with inlining enabled or
not, which is useful for trading-off compile-time and run-time
performance.  Fortunately, you need to <CODE>#include</CODE> only the
client stubs declared in the <tt>*C.h</tt> file and the skeletons in
the <tt>*S.h</tt> file in your code. Inline files are not generated
for CIAO servant or executor implementation code.<P>

<HR><P>
<a name="idl_env"><h3>Environment Variables</h3></a>

<TABLE BORDER=2 CELLSPACING=2 CELLPADDING=0>
  <TH>Variable
  <TH>Usage
  <TR>
    <TD>TAO_IDL_PREPROCESSOR
    <TD>Used to override the program name of the preprocessor that TAO_IDL
            uses.
  <TR>
    <TD>TAO_IDL_PREPROCESSOR_ARGS
    <TD>Used to override the flags passed to the preprocessor that TAO_IDL
        uses.  This can be used to alter the default options for the
        preprocessor and specify things like include directories and how
        the preprocessor is invoked.  Two flags that will always be passed to
        the preprocessor are <CODE>-DIDL</CODE> and <CODE>-I.</CODE>.
  <TR>
    <TD>TAO_ROOT
        <TD>Used to determine where <CODE>orb.idl</CODE> is located.
  <TR>
    <TD>ACE_ROOT
        <TD>Used to determine where <CODE>orb.idl</CODE> is located.
  <TR>
    <td>CIAO_ROOT
        <TD>Used to determine where <code>Components.idl</code> is located.</TD>
    </td>
  </TR>
</TABLE>

<P>Because TAO_IDL doesn't have any code to implement a preprocessor, it has
to use an external one.  For convenience, it uses a built-in name for an external
preprocessor to call.  During compilation, this is how that default is set:</P>

<OL>
  <LI>If the macro TAO_IDL_PREPROCESSOR is defined, then it will use that.
  <LI>Else if the macro ACE_CC_PREPROCESSOR is defined, then it will use that.
  <LI>Otherwise, it will use "cc"
</OL>

<P>And the same behavior occurs for the TAO_IDL_PREPROCESSOR_ARGS and
ACE_CC_PREPROCESSOR_ARGS macros.</P>

<P>Case 1 is used by the Makefile on most machines to specify the preprocessor.
Case 2 is used on Windows and platforms that need special arguments passed
to the preprocessor (MVS, HPUX, etc.).  And case 3 isn't used at all,
but is included as a default case.</P>

<P>Since the default preprocessor may not always work when TAO_IDL is moved to
another machine or used in cross-compilation, it can be overridden at runtime
by setting the environment variables TAO_IDL_PREPROCESSOR and
TAO_IDL_PREPROCESSOR_ARGS.</P>

<P>In previous versions, the environment variables CPP_LOCATION and
TAO_IDL_DEFAULT_CPP_FLAGS were used for this purpose.  Both will still work,
but TAO_IDL will display a deprecation warning if it detects one of these.
It is possible that support for these old variables will be removed in a
future version of TAO.</P>

<P>If ACE_ROOT or TAO_ROOT are defined, then TAO_IDL
will use them to include the $(ACE_ROOT)/TAO/tao or $(TAO_ROOT)/tao
directories. This is to allow TAO_IDL to automatically find
&lt;orb.idl&gt; when it is included in an IDL file.  TAO_IDL will
display a warning message when neither is defined.</P>

<HR><P>
<h3>Operation Demuxing Strategies</h3>

The server skeleton can use different demuxing strategies to match the
incoming operation with the correct operation at the servant.  TAO's
IDL compiler supports perfect hashing, binary search, and dynamic
hashing demuxing strategies.  By default, TAO's IDL compiler tries to
generate perfect hash functions, which is generally the most <A
HREF="http://www.dre.vanderbilt.edu/~schmidt/PDF/COOTS-99.pdf">efficient and
predictable operation demuxing technique</A>.  To generate perfect
hash functions, TAO's IDL compiler uses <a
href="http://www.dre.vanderbilt.edu/~schmidt/PDF/gperf.pdf">gperf </a>, which
is a general-purpose perfect hash function generator. <P>

To configure TAO's IDL compiler to support perfect hashing please do
the following:

<ul>
  <LI>Enable <CODE>ACE_HAS_GPERF</CODE> when building ACE and TAO.
      This macro has been defined for the platforms where <CODE>gperf</CODE>
      has been tested, which includes most <A
      HREF="http://www.cs.wustl.edu/~schmidt/ACE-versions-i.html">platforms</A>
      that ACE runs on. <P>

  <li>Build the <CODE>gperf</CODE> in $ACE_ROOT/apps/gperf.  This build
      also leaves a copy/link of the ace_gperf program at the $ACE_ROOT/bin
      directory.<P>

  <li>Set the environment variable $ACE_ROOT appropriately or add
      $ACE_ROOT/bin to your search path. <P>

  <li>Use the <CODE>-g</CODE> option for the TAO IDL compiler or set
      your search path accordingly to install <CODE>ace_gperf</CODE> in a
      directory other than $ACE_ROOT/bin.
</ul>

Note that if you can't use perfect hashing for some reason the next
best operation demuxing strategy is binary search, which can be
configured using TAO's IDL compiler <A HREF="#options">options</A>.<P>

<HR><P>
<h3>AMI support</h3>

The TAO_IDL compiler generates AMI stubs and skeletons as
described in the CORBA 3.0.3 specification.

<hr><p>
<h3><a name="collocation-stubs">Collocation Strategies</a></h3>

TAO_IDL can generate collocated stubs using two different collocation
strategies.  It also allows you to suppress/enable the generation of
the stubs of a particular strategy.  To gain great flexibility at
run-time, you can generate stubs for both collocation strategies
(using both '<a href="#Gp"><code>-Gp</code></a>' and '<a
href="#Gd"><code>-Gd</code></a>' flags at the same time) and defer the
determination of collocation strategy until run-time.  On the other
hand, if you want to minimize the footprint of your program, you might
want to pre-determine the collocation strategy you want and only
generate the right collocated stubs (or not generating any at all using
both  '<a href="#Sp"><code>-Sp</code></a>' and '<a
href="#Sd"><code>-Sd</code></a>' flags at the same time if
it's a pure client.)  See our <a
href="http://www.dre.vanderbilt.edu/~schmidt/PDF/C++-report-col18.pdf">collocation
paper</a> for a detail discussion on the collocation support in
TAO.<p>


<HR><P>
<h3><A NAME="options">TAO's IDL Compiler Options</A></h3>

TAO's IDL compiler invokes your <tt>C</tt> (or <tt>C++</tt>)
preprocessor to resolve included IDL files.  It receives the common
options for preprocessors (such as <tt>-D</tt> or <tt>-I</tt>).  It
also receives other options that are specific to it.<p>

<table BORDER=2 CELLSPACING=2 CELLPADDING=0>
  <tr>
    <th>Option</th>
    <th>Description</th>
    <th>Remark</th>
  </tr>
  <tr><a NAME="u">
    <td><tt>-h</br>--help</br>-u</tt></td>

    <td>The compiler prints out the arguments it supports and exits</td>
    <td>&nbsp;</td>
  </tr>

  <tr> <a NAME="V">
    <td><tt>-V</br>--version</tt></td>

    <td>The compiler printouts its version and exits</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>--idl-version VERSION</tt></td>

    <td>Set the IDL version to use</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>--default-idl-version</tt></td>

    <td>Prints the default IDL version for the compiler and exits</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>--list-idl-versions</tt></td>

    <td>Lists IDL versions the compiler supports and exits</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Wb">
    <td><tt>-Wb,</tt><i>option_list</i></EM</TD></td>

    <td>Pass options to the TAO IDL compiler backend.</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="skel_export_macro">
    <td></td>

    <td><tt>skel_export_macro=</tt><i>macro_name</i></td>

    <td>The compiler will emit <i>macro_name</i> right after each <tt>class</tt>
        or <tt>extern</tt> keyword in the generated skeleton header (*S.h)
        files. If CIAO servant code is being generated (see <tt>-Gsv</tt> option below),
        and <tt>svnt_export_macro</tt> (see below) isn't set, this macro will also
        appear in the generated CIAO servant (*_svnt.h) files, since skeleton and
        CIAO servant files are often compiled together.
        This macro is needed for Windows and newer versions of gcc, which require
        special directives to export symbols from DLLs, otherwise the definition
        is just a space.&nbsp;</td>
  </tr>

  <tr><a name="skel_export_include">
    <td></td>

    <td><tt>skel_export_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of the generated server header, this is usually a good
        place to define the server side export macro.</td>
  </tr>

  <tr><a name="stub_export_macro">
    <td></td>

    <td><tt>stub_export_macro=</tt><i>macro_name</i></td>

    <td>The compiler will emit <i>macro_name</i> right after each <tt>class</tt>
        or <tt>extern</tt> keyword in the generated stub code, this is
        needed for Windows and newer versions of gcc, which require special directives to
        export symbols from DLLs, otherwise the definition is just a
        space.&nbsp;</td>
  </tr>

  <tr><a name="stub_export_include">
    <td></td>

    <td><tt>stub_export_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of the client header, this is usually a good place to define the export
        macro.</td>
  </tr>

  <tr><a name="anyop_export_macro">
    <td></td>

    <td><tt>anyop_export_macro=</tt><i>macro_name</i></td>

    <td>The compiler will emit <i>macro_name</i> before each Any operator
        or <tt>extern</tt> typecode declaration in the generated stub code,
        this is needed for Windows and newer versions of gcc, which require special directives to
        export symbols from DLLs, otherwise the definition is just a
        space on Unix platforms. This option works only in conjunction with
        the -GA option, which generates Any operators and typecodes into a
        separate set of files.&nbsp;</td>
  </tr>

  <tr><a name="anyop_export_include">
    <td></td>

    <td><tt>anyop_export_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of the anyop file header, this is usually a good place to define the export
        macro. This option works in conjunction with the -GA option, which generates Any
        operators and typecodes into a separate set of files.</td>
  </tr>

  <tr><a name="svnt_export_macro"></a>
    <td></td>

    <td><tt>svnt_export_macro=</tt><i>macro_name</i></td>

    <td>The compiler will emit <i>macro_name</i> right after each <tt>class</tt>
        or <tt>extern</tt> keyword in the generated CIAO servant code, if such
        code is being generated (see <tt>-Gsv</tt> option below). Since skeleton
        and servant files are often compiled together, the value of
        <tt>skel_export_macro</tt> will appear here, if it is set and
        <tt>svnt_export_macro</tt> is not. These macros
        are needed for Windows and newer versions of gcc, which require special directives to
        export symbols from DLLs - otherwise the definition is just a space.&nbsp;</td>
  </tr>

  <tr><a name="svnt_export_include"></a>
    <td></td>

    <td><tt>svnt_export_macro=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of the CIAO servant file header, if this file is being generated
        (see <tt>-Gsv</tt> option below). This is usually a good place to define the export
        macro.</td>
  </tr>

  <tr><a name="exec_export_macro"></a>
    <td></td>

    <td><tt>exec_export_macro=</tt><i>macro_name</i></td>

    <td>The compiler will emit <i>macro_name</i> right after each <tt>class</tt>
        or <tt>extern</tt> keyword in the generated CIAO executor implementation header
        (*_exec.h) files, if such
        code is being generated (see <tt>-Gex</tt> option below). These macros
        are needed for Windows and newer versions of gcc, which require special directives to
        export symbols from DLLs - otherwise the definition is just a space.&nbsp;</td>
  </tr>

  <tr><a name="exec_export_include"></a>
    <td></td>

    <td><tt>exec_export_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of the CIAO executor implementation header (*_exec.h) file, if this file is being generated
        (see <tt>-Gex</tt> option below). This is usually a good place to define the export
        macro.</td>
  </tr>

  <tr><a name="conn_export_macro"></a>
    <td></td>

    <td><tt>conn_export_macro=</tt><i>macro_name</i></td>

    <td>The compiler will emit <i>macro_name</i> right after each <tt>class</tt>
        or <tt>extern</tt> keyword in the generated CIAO connector implementation header
        (*_conn.h) files, if such
        code is being generated (see <tt>-Gcn</tt> option below). These macros
        are needed for Windows and newer versions of gcc, which require special directives to
        export symbols from DLLs - otherwise the definition is just a space.&nbsp;</td>
  </tr>

  <tr><a name="conn_export_include"></a>
    <td></td>

    <td><tt>conn_export_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of the CIAO connector implementation header (*_conn.h) file, if this file is being generated
        (see <tt>-Gcn</tt> option below). This is usually a good place to define the export
        macro.</td>
  </tr>

  <tr><a name="export_macro">
    <td></td>

    <td><tt>export_macro=</tt><i>macro_name</i></td>

    <td>This option has the same effect as issuing<br>
        <tt>-Wb,skel_export_macro=</tt><i>macro_name</i><br>
        <tt>-Wb,stub_export_macro=</tt><i>macro_name</i><br>
        <tt>-Wb,anyop_export_macro=</tt><i>macro_name</i>.<br>
        <tt>-Wb,svnt_export_macro=</tt><i>macro_name</i><br>
        <tt>-Wb,exec_export_macro=</tt><i>macro_name</i><br>
        <tt>-Wb,conn_export_macro=</tt><i>macro_name</i><br>
        This option is useful when building a single DLL
        or when some code generation is suppressed or not triggered
        (see option <tt>-SS</tt> below). </td>
  </tr>

  <tr><a name="export_include">
    <td></td>

    <td><tt>export_include=</tt><i>include_path</i></td>

    <td>This option has the same effect as specifying<br>
        <tt>-Wb,stub_export_include=</tt><i>include_path</i><br>
        <tt>-Wb,skel_export_include=</tt><i>include_path</i><br>
        <tt>-Wb,anyop_export_include=</tt><i>include_path</i>.<br>
        <tt>-Wb,svnt_export_include=</tt><i>include_path</i><br>
        <tt>-Wb,exec_export_include=</tt><i>include_path</i><br>
        <tt>-Wb,conn_export_include=</tt><i>include_path</i><br>
        This option goes with the previous option to build a DLL containing
        all code generation, or when some code generation is suppressed
        (see option <tt>-SS</tt> below).</td>
  </tr>

  <tr><a name="pch_include">
    <td></td>

    <td><tt>pch_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of all TAO IDL compiler generated files.  This can be used with a
        precompiled header mechanism, such as those provided by Borland
        C++Builder or MSVC++.</td>
  </tr>

  <tr><a name="obv_opt_accessor">
    <td></td>

    <td><tt>obv_opt_accessor</tt></td>

    <td>The IDL compiler will generate code to optimize access to base class data
        for valuetypes.</td>
  </tr>

  <tr><a name="pre_include">
    <td></td>

    <td><tt>pre_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        top of the each header file, before any other include statements. For
        example, ace/pre.h, which pushes compiler options for the Borland C++
        Builder and MSVC++ compilers, is included in this manner in all
        IDL-generated files in the TAO libraries and CORBA services.</td>
  </tr>

  <tr><a name="post_include">
    <td></td>

    <td><tt>post_include=</tt><i>include_path</i></td>

    <td>The compiler will generate code to include <i>include_path</i> at the
        bottom of the each header file. For example, ace/post.h, which pops
        compiler options for the Borland C++ Builder and MSVC++ compilers, is
        included in this manner in all IDL-generated files in the TAO libraries
        and CORBA services.</td>
  </tr>

  <tr><a name="include_guard">
    <td></td>

    <td><tt>include_guard=</tt><i>define</i></td>

    <td>The compiler will generate code the define in the C.h file to prevent
        users from including the generated C.h file. Useful for regenerating
        the pidl files in the archive.</td>
  </tr>

  <tr><a name="safe_include">
    <td></td>

    <td><tt>safe_include=</tt><i>file</i></td>

    <td>File that the user should include instead of this generated C.h file.
        Useful for regenerating the pidl files in the archive.</td>
  </tr>

  <tr><a name="unique_include">
    <td></td>

    <td><tt>unique_include=</tt><i>file</i></td>

    <td>File that the user should include instead of the normal includes in the C.h file.
        Useful for regenerating the *_include pidl files in the archive.</td>
  </tr>

  <tr><a name="stripped_filename">
    <td></td>

    <td><tt>stripped_filename=</tt><i>file</i></td>

    <td>File that should be generated as stripped_filename instead of taking
        the stripped filename of the input file.</td>
  </tr>

  <tr><a name="ciao_container_type">
    <td></td>

    <td><tt>ciao_container_type=</tt><i>file</i></td>

    <td>Type of container we are going to use, Session by default.</td>.
  </tr>

  <tr><a name="E">
    <td><tt>-E</tt></td>

    <td>Invoke only the preprocessor</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Wp">
    <td><tt>-Wp,</tt><i>option_list</i></EM</TD></td>

    <td>Pass options to the preprocessor.</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>--syntax-only</tt></td>

    <td>Parse input files, but exit without generating any files.</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="d">
    <td><tt>--dump </br> -d</tt></td>

    <td>Causes output of a dump of the AST and exits before any files would be
      created.</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>--dump-builtins</tt></td>

    <td>Implies --dump, but also dumps IDL defined by the compiler.</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>--just-dump-builtins</tt></td>

    <td>Dumps IDL defined by the compiler but ignores any files passed and
      exits.</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="D">
    <td><tt>-D</tt><i>macro_definition</i></td>

    <td>It is passed to the preprocessor</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="U">
    <td><tt>-U</tt><i>macro_name</i></td>

    <td>It is passed to the preprocessor</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="I">
    <td><tt>-I</tt><i>include_path</i></td>

    <td>It is passed to the preprocessor</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="A">
    <td><tt>-A</tt><i>assertion</i></td>

    <td>It is passed to the preprocessor</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Y">
    <td><tt>-Yp,<i>path</i></tt></td>

    <td>Specifies the path for the C preprocessor</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="H perfect_hash">
    <td><tt>-H perfect_hash</tt></td>

    <td>To specify the IDL compiler to generate skeleton code that uses perfect
        hashed operation demuxing strategy, which is the default strategy. Perfect
        hashing uses <a href="http://www.dre.vanderbilt.edu/~schmidt/PDF/gperf.pdf">gperf
        </a>program,
        to generate demuxing methods.&nbsp;</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="H dynamic_hash">
    <td><tt>-H dynamic_hash</tt></td>

    <td>To specify the IDL compiler to generate skeleton code that uses dynamic
        hashed operation demuxing strategy.&nbsp;</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="H binary_search">
    <td><tt>-H binary_search</tt></td>

    <td>To specify the IDL compiler to generate skeleton code that uses binary
        search based operation demuxing strategy.&nbsp;</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="H linear_search">
    <td><tt>-H linear_search</tt></td>

    <td>To specify the IDL compiler to generate skeleton code that uses linear
        search based operation demuxing strategy.  Note that this option is for testing purposes only and should not be used for production code since it's inefficient.</td>
    <td>&nbsp;</td>
  </tr>


  <tr><a name="in">
    <TD><TT>-in</TT></TD>
    <TD> To generate #include statements with &lt;&gt;'s for the standard
        include files (e.g. tao/corba.h) indicating them as non-changing
        files</TD>
    <td>&nbsp;</td>
  </TR>


  <TR><A NAME="ic">
    <TD><TT>-ic</TT></TD>
    <TD> To generate #include statements with ""s for changing
        standard include files (e.g. tao/corba.h). </TD>
    <td>&nbsp;</td>
  </TR>

  <tr><a name="g">
    <td><tt>-g </tt><i>path</i></td>

    <td>To specify the path for the perfect hashing program (GPERF). Default
        is $ACE_ROOT/bin/ace_gperf.&nbsp;</td>
    <td>&nbsp;</td>
  </tr>

  <TR><A NAME="iC">
    <TD><TT>-iC </TT><i>path</i></TD>
    <TD> Generate #included stubs in *A.h prefixed with this path. </TD>
    <td>Default is local filename only (no prefix).&nbsp;</td>
  </TR>

  <tr><a name="o">
    <td><tt>-o </tt><i>path</i></td>

    <td>To specify the output directory to IDL compiler as to where all the
        IDL-compiler-generated files are to be put. By default, all the files are
        put in the current directory from where&nbsp;<tao_idl>is called.&nbsp;</td>
    <td>If the specified directory does not exist, it will be created, if any path
        that may precede the directory name already exists. If the directory
        itself already exists, no action is taken.&nbsp;</td>
  </tr>

  <tr><a name="oS">
    <td><tt>-oS </tt><i>path</i></td>

    <td>Same as -o option but applies only to generated *S.* files&nbsp;</td>
    <td>Default is value of -o option or current directory&nbsp;</td>
  </tr>

  <tr><a name="oA">
    <td><tt>-oA </tt><i>path</i></td>

    <td>Same as -o option but applies only to generated *A.* files&nbsp;</td>
    <td>Default is value of -o option or current directory&nbsp;</td>
  </tr>

  <tr><a name="oE">
    <td><tt>-oE </tt><i>path</i></td>

    <td>Same as -o option but applies only to generated *_exec.* files&nbsp;</td>
    <td>Default is value of -o option or current directory&nbsp;</td>
  </tr>

  <tr><a name="oN">
    <td><tt>-oN </tt><i>path</i></td>

    <td>Do not overwrite *_exec.* files&nbsp;</td>
    <td>When -Gex option is used, executor implementation files shouldn't be overwritten
      if they are already in the output directory.&nbsp;</td>
  </tr>

  <tr><a name="hc">
    <td><tt>-hc</tt></td>

    <td>Client's header file name ending. Default is "C.h".</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="hs">
    <td><tt>-hs</tt></td>

    <td>Server's header file name ending. Default is "S.h".</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="hT">
    <td><tt>-hT</tt></td>

    <td>Server's template header file name ending. Default is "S_T.h".</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="cs">
    <td><tt>-cs</tt></td>

    <td>Client stub's file name ending. Default is "C.cpp".</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="ci">
    <td><tt>-ci</tt></td>

    <td>Client inline file name ending. Default is "C.inl".</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="ss">
    <td><tt>-ss</tt></td>

    <td>Server skeleton file name ending. Default is "S.cpp".</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="sT">
    <td><tt>-sT</tt></td>

    <td>Server template skeleton file name ending. Default is "S_T.cpp".</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="t">
    <td><tt>-t</tt></td>

    <td>Temporary directory to be used by the IDL compiler.
    </td>
    <td>Unix: use environment variable TEMPDIR if defined, else use /tmp/.
        Windows NT/2000/XP:
        use environment variable TMP or TEMP if defined, else use the
        Windows directory.
    </td>
  </tr>

  <tr><a name="Cw">
    <td><tt>-Cw</tt></td>

    <td>Output a warning if two identifiers in the same scope differ in
        spelling only by case (default is output of error message).</td>

    <td>This option has been added as a nicety for dealing with legacy
        IDL files, written when the CORBA rules for name resolution
        were not as stringent.</td>
  </tr>

  <tr><a name="Ce">
    <td><tt>-Ce</tt></td>

    <td>Output an error if two identifiers in the same scope differ in
        spelling only by case (default).</td>

    <td>&nbsp;</td>
  </tr>

  <tr><a name="ae">
    <td><tt>-ae</tt></td>

    <td>Output an error if an anonymous type is seen. Anonymous types are
        deprecated by the OMG spec (default is no output).</td>

    <td>This behavior can be selected globally by defining IDL_ANON_ERROR in
        config.h. It may then be overridden locally by
        <tt>-aw</tt> or <tt>-as</tt></td>
  </tr>

  <tr><a name="aw">
    <td><tt>-aw</tt></td>

    <td>Output a warning if an anonymous type is seen. Anonymous types are
        deprecated by the OMG spec (default is no output).</td>

    <td>This behavior can be selected globally by defining IDL_ANON_WARNING in
        config.h. It may then be overridden locally by
        <tt>-ae</tt> or <tt>-as</tt></td>
  </tr>

  <tr><a name="as">
    <td><tt>-as</tt></td>

    <td>Silence any diagnostic output for anonymous types (default).</td>

    <td>This behavior can be selected globally by defining IDL_ANON_SILENT in
        config.h. It may then be overridden locally by
        <tt>-aw</tt> or <tt>-ae</tt></td>
  </tr>

  <tr><a name="GC flag">
    <td><tt>-GC </tt></td>

    <td>Generate AMI stubs ("sendc_" methods, reply handler stubs, etc)</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="GH flag">
    <td><tt>-GH </tt></td>

    <td>Generate AMH stubs, skeletons, exception holders, etc.</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="GM flag">
    <td><tt>-GM </tt></td>

    <td>Generate AMI4CCM code</td>
    <td>*A.idl file (containing callback interface, "sendc_" methods
        and CCM connector) plus addition to CCM servant and executor</td>
  </tr>

  <tr><a name="Gp">
    <td><tt>-Gp </tt></td>

    <td>Generated collocated stubs that use <code>Thru_POA</code> collocation strategy (default)</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Gd">
    <td><tt>-Gd </tt></td>

    <td>Generated collocated stubs that use <code>Direct</code> collocation strategy</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Gce">
    <td><tt>-Gce </tt></td>

    <td>Generated code for CORBA/e. This reduces the size of the generated code</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Gmc">
    <td><tt>-Gmc </tt></td>

    <td>Generated code for Minimum CORBA. This reduces the size of the generated code</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Gcl">
    <td><tt>-Gcl </tt></td>

    <td>Generated code for LwCCM. This reduces the size of the generated code</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Gsp">
    <td><tt>-Gsp </tt></td>

    <td>Generate client smart proxies</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Gt">
    <td><tt>-Gt</tt></td>

    <td>Generate optimized TypeCodes</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="GX">
    <td><tt>-GX</tt></td>

    <td>Generate empty A.h file</td>
    <td>Used by TAO developers for generating an empty A.h file when the
        -GA option can't be used. Overrides -Sa and -St.
    </td>
  </tr>

  <tr><a name="Guc">
    <td><tt>-Guc</tt></td>

    <td>Generate uninlined constant if defined in a module</td>
    <td>Inlined (assigned a value in the C++ header file) by default, but this causes a
      problem with some compilers when using pre-compiled headers. Constants declared
    at global scope are always generated inline, while those declared in an interface
    or a valuetype never are - neither case is affected by this option.</td>
  </tr>

  <tr><a name="Gsd">
    <td><tt>-Gsd</tt></td>

    <td>Generate static description operations</td>
    <td>Generate static description operations to retrieve the repository id
        or interface name as string. Can be useful for template programming</td>
  </tr>

  <tr><a name="Gse">
    <td><tt>-Gse</tt></td>

    <td>Generate explicit export of sequence's template base class</td>
    <td>Occasionally needed as a workaround for a bug in Visual Studio
        (.NET 2002, .NET 2003 and Express 2005) where the template
        instantiation used for the base class isn't automatically exported</td>
  </tr>

  <tr>
    <td><tt>-GI</tt></td>

    <td>Generate boiler-plate files that contain empty servant implementations </td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>-GIh </tt><i>arg</i></td>

    <td>Servant implementation header file name ending</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>-GIs </tt><i>arg</i></td>

    <td>Servant implementation skeleton file name ending</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>-GIb </tt><i>arg</i></td>

    <td>Prefix to the implementation class names</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>-GIe </tt><i>arg</i></td>

    <td>Suffix to the implementation class names</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>-GIc</tt></td>

    <td>Generate copy constructors in the servant implementation template files</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>-GIa</tt></td>

    <td>Generate assignment operators in the servant implementation template files</td>
    <td>&nbsp;</td>
  </tr>

  <tr>
    <td><tt>-GId</tt></td>

    <td>Generate IDL compiler source file/line# debug info in implementation files</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="GT">
    <td><tt>-GT</tt></td>

    <td>Enable generation of the TIE classes, and the *S_T.* files that
    contain them.</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="GA">
    <td><tt>-GA</tt></td>

    <td>Generate type codes and Any operators in *A.h and *A.cpp</td>
    <td>Decouples client and server decisions to compile and link
        TypeCode- and Any-related code, which is generated in
        *C.h and *C.cpp by default. If -Sa or -St also appear, then
        an empty *A.h file is generated.</td>
  </tr>

  <tr><a name="Gos">
    <td><tt>-Gos</tt></td>

    <td>Generate std::ostream insertion operators for IDL declarations</td>
    <td>ORB IDL declarations (including the basic type sequences) don't
        have these operators generated by default, to avoid the increased
        footprint. To turn on this generation for ORB IDL files, set
        <tt>gen_ostream=1</tt> in your <i>default.features</i> MPC file.
        If this option is used on application IDL that references any of
        the predefined basic sequence IDL types, TAO must be compiled
        with the <tt>gen_ostream</tt> feature turned on.</td>
  </tr>

  <tr><a name="Gata">
    <td><tt>-Gata</tt></td>

    <td>Generate the AnyTypeCode_Adapter version of the Any insert policy</td>
    <td>When generating arg traits instantiations, this option forces
        (if Any support in general is not suppressed) the generation
        of <code>Any_Insert_Policy_AnyTypeCode_Adapter</code> for the
        last template parameter. This option is used when generating
        arg traits for the sequences of basic types in the ORB, so
        their arg traits may be included in files generated from
        application IDL whether Any support is suppressed in the
        application IDL processing or not.</td>
  </tr>

  <tr><a name="Gsv">
    <td><tt>-Gsv</tt></td>

    <td>Generate CIAO servant code for component and home IDL declarations</td>
  </tr>

  <tr><a name="Gex">
    <td><tt>-Gex</tt></td>

    <td>Generate CIAO executor implementation code for component and home IDL declarations</td>
    <td>
    These files have empty function bodies for all facet, supported and inherited operations,
    to be filled in by the developer.</td>
  </tr>

  <tr><a name="Gexr">
    <td><tt>-Gexr</tt></td>

    <td>Generate CIAO executor implementation code for component and home IDL declarations, including
      an implementation of the ACE_Reactor</td>
    <td>When applying <tt>-Gexr</tt>, the TAO IDL compiler will generate an extra method which
      retrieves the ACE_Reactor from the ORB. One should use this option when an ACE_reactor.
      In code, use 'this-&gt;reactor ()' to get the ACE_Reactor. A CORBA::INTERNAL
      exception is thrown when the ACE_Reactor cannot be retrieved.<br/>
      The goal of this method is to prevent memory leaks.</td>
  </tr>

  <tr><a name="Gcn">
    <td><tt>-Gcn</tt></td>

    <td>Generate CIAO connector implementation code for connector IDL declarations</td>
    <td>Generate a complete implementation for each connector. Specialized at present
    for DDS connectors.</td>
  </tr>

  <tr><a name="Gts">
    <td><tt>-Gts</tt></td>

    <td>Generate DDS type support IDL in a separate IDL file</td>
    <td>Not used with OpenDDS, since OpenDDS's IDL processor does this already.</td>
  </tr>

  <tr><a name="Glem">
    <td><tt>-Glem</tt></td>

    <td>Generate CIAO executor IDL for component and home IDL declarations</td>
  </tr>

  <tr><a name="Gsw">
    <td><tt>-Gsw</tt></td>

    <td>Generate CIAO servant code to support component swapping</td>
    <td>Modify the generated servant code and container file includes
    to support on-the-fly swapping of components.</td>
  </tr>

  <tr><a name="Gxhst">
    <td><tt>-Gxhst</tt></td>

    <td>Generate the stub export header file</td>
    <td>This is the file specified in <tt>-Wb,stub_export_include=<i>include_path</i></tt></td>
  </tr>

  <tr><a name="Gxhsk">
    <td><tt>-Gxhsk</tt></td>

    <td>Generate the skeleton export header file</td>
    <td>This is the file specified in <tt>-Wb,skel_export_include=<i>include_path</i></tt></td>
  </tr>

  <tr><a name="Gxhsv">
    <td><tt>-Gxhsv</tt></td>

    <td>Generate the CIAO servant export header file</td>
    <td>This is the file specified in <tt>-Wb,svnt_export_include=<i>include_path</i></tt></td>
  </tr>

  <tr><a name="Gxhex">
    <td><tt>-Gxhex</tt></td>

    <td>Generate the executor export header file</td>
    <td>This is the file specified in <tt>-Wb,exec_export_include=<i>include_path</i></tt></td>
  </tr>

  <tr><a name="Gxhcn">
    <td><tt>-Gxhcn</tt></td>

    <td>Generate the connector export header file</td>
    <td>This is the file specified in <tt>-Wb,conn_export_include=<i>include_path</i></tt></td>
  </tr>

  <tr><a name="Sa">
    <td><tt>-Sa</tt></td>

    <td>Suppress generation of the Any operators</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Sal">
    <td><tt>-Sal</tt></td>

    <td>Suppress generation of the Any operators for local interfaces only</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Sat">
    <td><tt>-Sat</tt></td>

    <td>Suppress generation of arg traits instantiations</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Sp">
    <td><tt>-Sp</tt></td>

    <td>Suppress generation of collocated stubs that use <code>Thru_POA</code> collocation strategy</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="Sd">
    <td><tt>-Sd</tt></td>

    <td>Suppress generation of collocated stubs that use <code>Direct</code> collocation strategy (default)</td>
    <td>&nbsp;</td>
  </tr>

  <tr><a name="St">
    <td><tt>-St</tt></td>

    <td>Suppress generation of typecodes</td>

    <td>Also suppresses the generation of the Any operators, since they need the
        associated typecode.</td>
  </tr>

  <tr><a name="Sm">
    <td><tt>-Sm</tt></td>

    <td>Suppress C++ code generation from CCM 'implied' IDL.</td>
    <td>This code generation is achieved by default using a 'preprocessing' visitor
        that modified the AST and is launched just before the code generating
        visitors. There is a new tool in CIAO that converts the entire IDL file
        into one containing explicit declarations of the implied IDL types.
        For such a file, we don't want the preprocessing visitor to be launched,
        so this command line option will suppress it.</td>
  </tr>

  <tr><a name="SS">
    <td><tt>-SS</tt></td>

    <td>Suppress generation of the skeleton implementation and inline file.</td>
    <td>This option doesn't check whether something is generated in the files. It
        just suppresses them without looking at any possible contents;</td>
  </tr>

  <tr><a name="Sci">
    <td><tt>-Sci</tt></td>

    <td>Suppress generation of the client inline file.</td>
    <td>This option doesn't check whether something is generated in the file. It
        just suppresses it without looking at any possible contents;</td>
  </tr>

  <tr><a name="Scc">
    <td><tt>-Scc</tt></td>

    <td>Suppress generation of the client stub file.</td>
    <td>This option doesn't check whether something is generated in the file. It
        just suppresses it without looking at any possible contents;</td>
  </tr>

  <tr><a name="Sch">
    <td><tt>-Sch</tt></td>

    <td>Suppress generation of the client header file.</td>
    <td>This option doesn't check whether something is generated in the file. It
        just suppresses it without looking at any possible contents;</td>
  </tr>

  <tr><a name="Ssi">
    <td><tt>-Ssi</tt></td>

    <td>Suppress generation of the servant inline file.</td>
    <td>This option doesn't check whether something is generated in the file. It
        just suppresses it without looking at any possible contents;</td>
  </tr>

  <tr><a name="SS">
    <td><tt>-SS</tt></td>

    <td>Suppress generation of the servant skeleton file.</td>
    <td>This option doesn't check whether something is generated in the file. It
        just suppresses it without looking at any possible contents;</td>
  </tr>

  <tr><a name="Ssh">
    <td><tt>-Ssh</tt></td>

    <td>Suppress generation of the servant header file.</td>
    <td>This option doesn't check whether something is generated in the file. It
        just suppresses it without looking at any possible contents;</td>
  </tr>

  <tr><a name="Ssvntc">
    <td><tt>-Ssvntc</tt></td>

    <td>Suppress generation of the servant implementation file (_svnt.cpp).</td>
    <td>This option doesn't check whether something is generated in the files. It
        just suppresses them without looking at any possible contents;</td>
  </tr>

  <tr><a name="Ssvntt">
    <td><tt>-Ssvntt</tt></td>

    <td>Suppress generation of the servant templated files (_svnt_T.{h,cpp}).</td>
    <td>This option doesn't check whether something is generated in the files. It
        just suppresses them without looking at any possible contents;</td>
  </tr>

  <tr><a name="Sorb">
    <td><tt>-Sorb</tt></td>

    <td>Suppress generation of the ORB.h include.</td>
    <td>This option is useful when regenerating pidl files in the core
  TAO libs to prevent cyclic includes;</td>
  </tr>

  <tr><a name="Se">
    <td><tt>-Se</tt></td>

    <td>Disable custom header file name endings for files
        that are found in TAO specific include directories
        (i.e. $TAO_ROOT, $TAO_ROOT/tao, $TAO_ROOT/orbsvcs,
        $TAO_ROOT/CIAO, $TAO_ROOT/CIAO/ciao, $TAO_ROOT/CIAO/ccm).</td>
    <td>This option is useful when used together with -hs or -hc. I.e. when user
        needs custom file name endings for his/her own files but still wants to
        use TAO specific files with their original endings;</td>
  </tr>

  <tr><a name="Sg">
    <td><tt>-Sg</tt></td>

    <td>Disable generation of unique preprocessor guards for generated
        header files. The guards will still be generated, but without
        the unique random extension.</td>
    <td>This option is useful when a system has several versions of a
        generated header file, and only the newest version is to be
        included by the preprocessor. The default behavior will
        generate a unique extension for each version, subverting
        the desired function of the preprocessor in such a system.</td>
  </tr>

  <tr><a name="Sfr">
    <td><tt>-Sfr</tt></td>

    <td>Disable CIAO servant code generation to register valuetype
        factories for events.</td>
    <td>By default, the generated CIAO servant constructor will register
        a valuetype factory with the container ORB for each eventtype
        used in an event source or sink port. However, if an eventtype
        has a factory function or other operation, the generated
        valuetype factory class will be abstract and must be overridden
        by the user, and registered in hand-written code.</td>
  </tr>
  <tr><a name="TS">
    <td><tt>-TS <i>value</i></tt></td>

    <td>Set tab size for generated files</td>
    <td>Default is 2 spaces</td>
  </tr>

  <tr>
    <td><tt>--unknown-annotations ARG</tt></td>

    <td>
      Controls the reaction when encountering undefined annotations. The valid
      arguments to this option are "warn-once" (Default), "warn-all", "error",
      and "ignore".
    </td>
    <td>
      The difference between "warn-once" and "warn-all" is that with
      "warn-once" using annotations the same local name will not be warned
      about more than once, while "warn-all" will warn with every usage.
    </td>
  </tr>

</table> <P>

<P><HR><P>
Back to the TAO <A HREF="index.html">documentation</A>.

<!--#include virtual="/~schmidt/cgi-sig.html" -->

</body>
</html>
